Edit Task: SetPossibility ResourceRatePeriod
Description
The SetPossibility ResourceRatePeriod attribute under EditTask defines the resource usage's rate period duration for a single task possibility. This command does not change the amount of resource usage, only the rate (i.e. if a resource was set to be used at a rate of 10 Mb per minute, this command can only change the rate from 1 minute to another time).
Parameters
| Parameter | Description |
|---|---|
| PossibilityName | A string of text with a comma delimited list of resources in the possibility. Order is not required and the resource names should not be in quotes. |
| ResourceName | A string of text of the resource that is being defines within the command. |
| RatePeriod | A double value that represents seconds(millisecond fidelity) that is greater than 0.001. This is used in conjunction with the RateAmount to determine how much change will occur to the resource capacity per rate period when assigned. |
Examples
Change the resource usage rate to 20 seconds for ResB in the possibility that uses ResA, ResB and ResC.
PATCH api/task/TaskA
Body:
{
"SetResourceDetails" : {
"PossibilityName" : "ResA,ResB,ResC",
"ResourceName" : "ResB",
"RatePeriod" : "20" }
}
